Criar QR Code Pix dinâmico com vencimento

O QR Code dinâmico com vencimento é utilizado para pagamentos onde o originador é conhecido e é desejado facilitar o pagamento, possibilitando adicionar prazos, descontos, multas, e juros. Este QR Code é utilizado normalmente em substituição ao boleto bancário.

Request

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/qrcode

MÉTODO

POST

Request Body: Qr Code dinâmico com vencimento

{
  "request_control_key": "8a923886-afce-4116-ac1f-69bdffcf8da9",
  "qr_code_type": "dynamic_term",
  "amount": 10.25,
  "receiver_conciliation_id": "01GVGV9NXBCY287Z6CJ4S0ENW9",
  "payer_document_number": "00000000000000",
  "payer_name": "Random",
  "payer_request": "Payment for order XXXXXXXXXX",
  "pix_key": "3d7d6a2b-f72f-44c7-bb20-79a94dff5954",
  "expiration_date": "2023-03-25",
  "max_payment_days": 128,
  "fine_amount": 3,
  "interest_amount": 2,
  "rebate_amount": 1,
  "discounts": [],
  "additional_data": [
    {
      "key_name": "merchant_name",
      "value": "Lojas Costa S.A."
    }
  ],
}

Body Params

Campo	Tipo	Descrição	Caracteres
request_control_key *	string	Identificador UUID4 único da request.	-
qr_code_type *	string	Tipo do QR Code dinâmico.	"dynamic_term" ou "dynamic_instant"
amount *	float	Valor do QR Code antes do cálculo de descontos ou juros e multas.	-
receiver_conciliation_id *	string	Identificador do QR Code para conciliação após o pagamento.	-
payer_document_number *	string	CPF/ CNPJ do pagador.	-
payer_name *	string	Nome do pagador.	-
payer_request *	string	Mensagem ao pagador.	-
pix_key *	string	Chave Pix que representa a conta de destino da transação.	-
expiration_date *	date	Data de vencimento da cobrança (no formato "YYYY-MM-DD").	-
max_payment_days *	int32	Dias máximo para pagamento da cobrança.	-
fine_amount *	float	Multa em valor absoluto após o vencimento.	-
interest_amount *	float	Valor absoluto por dia de atraso após o vencimento, caso seja pago um dia após o vencimento o valor total será o valor ordinario + multa.	-
rebate_amount *	float	Valor absoluto de abatimento antes do pagamento.	-
discounts	array of objects	Configurações de desconto.	-
additional_data	array of objects	Informações extras do QR Code utilizado para conciliações.	-

Objeto additional_data

Campo	Tipo	Descrição	Caracteres
key_name *	string	Nome do campo	-
value *	string	Valor do campo	-

Objeto discount

Campo	Tipo	Descrição	Caracteres
discount_value *	float	Valor do desconto.	-
discount_number	int32	Ordem que o desconto deve ser aplicado.	-
discount_limit_date *	string	Data limite do desconto.	-

Response

STATUS

201 Created

Response Body: Criação Qr Code dinâmico com vencimento

{
  "request_control_key": "037b46b1-0c67-4c0d-aac3-1e395dfdcb10",
  "qr_code_key": "d74bf12a-9243-4bfa-9b00-6b63755b6555",
  "qr_code_status": "active",
  "base_64_payload": "<BASE64 DA URI DO PIX COPIA E COLA>",
  "created_at": "2023-03-03T12:04:06.179Z",
}

Campo	Tipo	Descrição	Caracteres
request_control_key *	string	Identificador UUID4 único da request.	-
qr_code_key *	string	Identificador do QR Code para futuras requisições.	-
qr_code_status *	string	Status do QR Code no sistema.	"active": default para criação.
base_64_payload *	string	URL do QR Code para pagamento, em base64.	-
created_at *	datetime	Data e hora que o QR Code foi criado no sistema.	-

Objeto qr_code_status

Campo	Tipo	Descrição	Caracteres
active	string	QR Code se encontra ativo e disponível para pagamento.	-
finished	string	QR Code pago.	-
written_off	string	QR Code foi baixado pelo cliente.	-
bank_written_off	string	QR Code foi baixado automaticamente devido prazo expirado.	-

STATUS

400

Response Body

{
    "title": "Bad Request",
    "description": "Invalid payload for QR Code creation.",
    "translation": "Payload inválido para a criação de QR Code.",
    "code": "QRI000003"
}